Vcenter Vm Hardware Serial BackingInfo

The Vcenter Vm Hardware Serial BackingInfo schema contains information about the physical resource backing a virtual serial port.

JSON Example

{
    "type": "string",
    "file": "string",
    "host_device": "string",
    "auto_detect": false,
    "pipe": "string",
    "no_rx_loss": false,
    "network_location": "string",
    "proxy": "string"
}

string

type

Required

Backing type for the virtual serial port.

For more information see: Vcenter Vm Hardware Serial BackingType.

string

file

Optional

Path of the file backing the virtual serial port.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Serial BackingType.FILE.

string

host_device

Optional

Name of the device backing the virtual serial port.

This property will be missing or null if auto_detect is true and the virtual serial port is not connected or no suitable device is available on the host.

boolean

auto_detect

Optional

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Serial BackingType.HOST_DEVICE.

string

pipe

Optional

Name of the pipe backing the virtual serial port.

This property is optional and it is only relevant when the value of type is one of Vcenter Vm Hardware Serial BackingType.PIPE_SERVER or Vcenter Vm Hardware Serial BackingType.PIPE_CLIENT.

boolean

no_rx_loss

Optional

Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.

This property is optional and it is only relevant when the value of type is one of Vcenter Vm Hardware Serial BackingType.PIPE_SERVER or Vcenter Vm Hardware Serial BackingType.PIPE_CLIENT.

string As uri As uri

network_location

Optional

URI specifying the location of the network service backing the virtual serial port.

If Vcenter Vm Hardware Serial BackingInfo.type is Vcenter Vm Hardware Serial BackingType.NETWORK_SERVER, this property is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
If Vcenter Vm Hardware Serial BackingInfo.type is Vcenter Vm Hardware Serial BackingType.NETWORK_CLIENT, this property is the location used by the virtual machine to connect to the remote server.

This property is optional and it is only relevant when the value of type is one of Vcenter Vm Hardware Serial BackingType.NETWORK_SERVER or Vcenter Vm Hardware Serial BackingType.NETWORK_CLIENT.

string As uri As uri

proxy

Optional

Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy.

If missing or null, no proxy service is configured.